Azure Container Registry (stable:2021-07-01)

2025/09/10 • 26 new methods

ContainerRegistry_CheckDockerV2Support (new)
Description Tells whether this Docker Registry instance supports Docker Registry HTTP API v2
Reference Link ¶

⚼ Request

GET:  /v2/
{}

⚐ Response (200)

{}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_GetManifest (new)
Description Get the manifest identified by `name` and `reference` where `reference` can be a tag or digest.
Reference Link ¶

⚼ Request

GET:  /v2/{name}/manifests/{reference}
{
name: string ,
reference: string ,
accept: string ,
}

⚐ Response (200)

{
mediaType: string ,
manifests:
[
{
mediaType: string ,
size: integer ,
digest: string ,
platform:
{
architecture: string ,
os: string ,
os.version: string ,
os.features:
[
string ,
]
,
variant: string ,
features:
[
string ,
]
,
}
,
}
,
]
,
config:
{
mediaType: string ,
size: integer ,
digest: string ,
urls:
[
string ,
]
,
annotations:
{
org.opencontainers.image.created: string ,
org.opencontainers.image.authors: string ,
org.opencontainers.image.url: string ,
org.opencontainers.image.documentation: string ,
org.opencontainers.image.source: string ,
org.opencontainers.image.version: string ,
org.opencontainers.image.revision: string ,
org.opencontainers.image.vendor: string ,
org.opencontainers.image.licenses: string ,
org.opencontainers.image.ref.name: string ,
org.opencontainers.image.title: string ,
org.opencontainers.image.description: string ,
}
,
}
,
layers:
[
{
mediaType: string ,
size: integer ,
digest: string ,
urls:
[
string ,
]
,
annotations:
{
org.opencontainers.image.created: string ,
org.opencontainers.image.authors: string ,
org.opencontainers.image.url: string ,
org.opencontainers.image.documentation: string ,
org.opencontainers.image.source: string ,
org.opencontainers.image.version: string ,
org.opencontainers.image.revision: string ,
org.opencontainers.image.vendor: string ,
org.opencontainers.image.licenses: string ,
org.opencontainers.image.ref.name: string ,
org.opencontainers.image.title: string ,
org.opencontainers.image.description: string ,
}
,
}
,
]
,
annotations:
{
org.opencontainers.image.created: string ,
org.opencontainers.image.authors: string ,
org.opencontainers.image.url: string ,
org.opencontainers.image.documentation: string ,
org.opencontainers.image.source: string ,
org.opencontainers.image.version: string ,
org.opencontainers.image.revision: string ,
org.opencontainers.image.vendor: string ,
org.opencontainers.image.licenses: string ,
org.opencontainers.image.ref.name: string ,
org.opencontainers.image.title: string ,
org.opencontainers.image.description: string ,
}
,
architecture: string ,
name: string ,
tag: string ,
fsLayers:
[
{
blobSum: string ,
}
,
]
,
history:
[
{
v1Compatibility: string ,
}
,
]
,
signatures:
[
{
header:
{
jwk:
{
crv: string ,
kid: string ,
kty: string ,
x: string ,
y: string ,
}
,
alg: string ,
}
,
signature: string ,
protected: string ,
}
,
]
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_CreateManifest (new)
Description Put the manifest identified by `name` and `reference` where `reference` can be a tag or digest.
Reference Link ¶

⚼ Request

PUT:  /v2/{name}/manifests/{reference}
{
name: string ,
reference: string ,
payload:
{
schemaVersion: integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
docker-content-digest: string ,
location: string ,
content-length: integer ,
}
,
$schema: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_DeleteManifest (new)
Description Delete the manifest identified by `name` and `reference`. Note that a manifest can _only_ be deleted by `digest`.
Reference Link ¶

⚼ Request

DELETE:  /v2/{name}/manifests/{reference}
{
name: string ,
reference: string ,
}

⚐ Response (202)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistryBlob_GetBlob (new)
Description Retrieve the blob from the registry identified by digest.
Reference Link ¶

⚼ Request

GET:  /v2/{name}/blobs/{digest}
{
name: string ,
digest: string ,
}

⚐ Response (200)

{
$headers:
{
content-length: integer ,
docker-content-digest: string ,
}
,
$schema: file ,
}

⚐ Response (307)

{
location: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistryBlob_CheckBlobExists (new)
Description Same as GET, except only the headers are returned.
Reference Link ¶

⚼ Request

HEAD:  /v2/{name}/blobs/{digest}
{
name: string ,
digest: string ,
}

⚐ Response (200)

{
content-length: integer ,
docker-content-digest: string ,
}

⚐ Response (307)

{
location: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistryBlob_DeleteBlob (new)
Description Removes an already uploaded blob.
Reference Link ¶

⚼ Request

DELETE:  /v2/{name}/blobs/{digest}
{
name: string ,
digest: string ,
}

⚐ Response (202)

{
$headers:
{
docker-content-digest: string ,
}
,
$schema: file ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistryBlob_MountBlob (new)
Description Mount a blob identified by the `mount` parameter from another repository.
Reference Link ¶

⚼ Request

POST:  /v2/{name}/blobs/uploads/
{
name: string ,
from: string ,
mount: string ,
}

⚐ Response (201)

{
location: string ,
docker-upload-uuid: string ,
docker-content-digest: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistryBlob_GetUploadStatus (new)
Description Retrieve status of upload identified by uuid. The primary purpose of this endpoint is to resolve the current status of a resumable upload.
Reference Link ¶

⚼ Request

GET:  /{nextBlobUuidLink}
{
nextBlobUuidLink: string ,
}

⚐ Response (204)

{
range: string ,
docker-upload-uuid: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistryBlob_UploadChunk (new)
Description Upload a stream of data without completing the upload.
Reference Link ¶

⚼ Request

PATCH:  /{nextBlobUuidLink}
{
value: object ,
nextBlobUuidLink: string ,
}

⚐ Response (202)

{
location: string ,
range: string ,
docker-upload-uuid: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistryBlob_CompleteUpload (new)
Description Complete the upload, providing all the data in the body, if necessary. A request without a body will just complete the upload with previously uploaded content.
Reference Link ¶

⚼ Request

PUT:  /{nextBlobUuidLink}
{
digest: string ,
value: object ,
nextBlobUuidLink: string ,
}

⚐ Response (201)

{
location: string ,
range: string ,
docker-content-digest: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistryBlob_CancelUpload (new)
Description Cancel outstanding upload processes, releasing associated resources. If this is not called, the unfinished uploads will eventually timeout.
Reference Link ¶

⚼ Request

DELETE:  /{nextBlobUuidLink}
{
nextBlobUuidLink: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_GetRepositories (new)
Description List repositories
Reference Link ¶

⚼ Request

GET:  /acr/v1/_catalog
{
last: string ,
n: integer ,
api-version: string ,
}

⚐ Response (200)

{
$headers:
{
link: string ,
}
,
$schema:
{
repositories:
[
string ,
]
,
link: string ,
}
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_GetProperties (new)
Description Get repository attributes
Reference Link ¶

⚼ Request

GET:  /acr/v1/{name}
{
name: string ,
api-version: string ,
}

⚐ Response (200)

{
registry: string ,
imageName: string ,
createdTime: string ,
lastUpdateTime: string ,
manifestCount: integer ,
tagCount: integer ,
changeableAttributes:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_DeleteRepository (new)
Description Delete the repository identified by `name`
Reference Link ¶

⚼ Request

DELETE:  /acr/v1/{name}
{
name: string ,
api-version: string ,
}

⚐ Response (202)

{
manifestsDeleted:
[
string ,
]
,
tagsDeleted:
[
string ,
]
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_UpdateProperties (new)
Description Update the attribute identified by `name` where `reference` is the name of the repository.
Reference Link ¶

⚼ Request

PATCH:  /acr/v1/{name}
{
name: string ,
value:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
api-version: string ,
}

⚐ Response (200)

{
registry: string ,
imageName: string ,
createdTime: string ,
lastUpdateTime: string ,
manifestCount: integer ,
tagCount: integer ,
changeableAttributes:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_GetTags (new)
Description List tags of a repository
Reference Link ¶

⚼ Request

GET:  /acr/v1/{name}/_tags
{
name: string ,
last: string ,
n: integer ,
orderby: string ,
digest: string ,
api-version: string ,
}

⚐ Response (200)

{
$headers:
{
link: string ,
}
,
$schema:
{
registry: string ,
imageName: string ,
tags:
[
{
name: string ,
digest: string ,
createdTime: string ,
lastUpdateTime: string ,
signed: boolean ,
changeableAttributes:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
}
,
]
,
link: string ,
}
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_GetTagProperties (new)
Description Get tag attributes by tag
Reference Link ¶

⚼ Request

GET:  /acr/v1/{name}/_tags/{reference}
{
name: string ,
reference: string ,
api-version: string ,
}

⚐ Response (200)

{
registry: string ,
imageName: string ,
tag:
{
name: string ,
digest: string ,
createdTime: string ,
lastUpdateTime: string ,
signed: boolean ,
changeableAttributes:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
}
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_UpdateTagAttributes (new)
Description Update tag attributes
Reference Link ¶

⚼ Request

PATCH:  /acr/v1/{name}/_tags/{reference}
{
name: string ,
reference: string ,
value:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
api-version: string ,
}

⚐ Response (200)

{
registry: string ,
imageName: string ,
tag:
{
name: string ,
digest: string ,
createdTime: string ,
lastUpdateTime: string ,
signed: boolean ,
changeableAttributes:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
}
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_DeleteTag (new)
Description Delete tag
Reference Link ¶

⚼ Request

DELETE:  /acr/v1/{name}/_tags/{reference}
{
name: string ,
reference: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_GetManifests (new)
Description List manifests of a repository
Reference Link ¶

⚼ Request

GET:  /acr/v1/{name}/_manifests
{
name: string ,
last: string ,
n: integer ,
orderby: string ,
api-version: string ,
}

⚐ Response (200)

{
$headers:
{
link: string ,
}
,
$schema:
{
registry: string ,
imageName: string ,
manifests:
[
{
digest: string ,
imageSize: integer ,
createdTime: string ,
lastUpdateTime: string ,
architecture: enum ,
os: enum ,
references:
[
{
digest: string ,
architecture: enum ,
os: enum ,
}
,
]
,
configMediaType: string ,
tags:
[
string ,
]
,
changeableAttributes:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
}
,
]
,
link: string ,
}
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_GetManifestProperties (new)
Description Get manifest attributes
Reference Link ¶

⚼ Request

GET:  /acr/v1/{name}/_manifests/{digest}
{
name: string ,
digest: string ,
api-version: string ,
}

⚐ Response (200)

{
registry: string ,
imageName: string ,
manifest:
{
digest: string ,
imageSize: integer ,
createdTime: string ,
lastUpdateTime: string ,
architecture: enum ,
os: enum ,
references:
[
{
digest: string ,
architecture: enum ,
os: enum ,
}
,
]
,
configMediaType: string ,
tags:
[
string ,
]
,
changeableAttributes:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
}
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
ContainerRegistry_UpdateManifestProperties (new)
Description Update properties of a manifest
Reference Link ¶

⚼ Request

PATCH:  /acr/v1/{name}/_manifests/{digest}
{
name: string ,
digest: string ,
value:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
api-version: string ,
}

⚐ Response (200)

{
registry: string ,
imageName: string ,
manifest:
{
digest: string ,
imageSize: integer ,
createdTime: string ,
lastUpdateTime: string ,
architecture: enum ,
os: enum ,
references:
[
{
digest: string ,
architecture: enum ,
os: enum ,
}
,
]
,
configMediaType: string ,
tags:
[
string ,
]
,
changeableAttributes:
{
deleteEnabled: boolean ,
writeEnabled: boolean ,
listEnabled: boolean ,
readEnabled: boolean ,
}
,
}
,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
Authentication_ExchangeAadAccessTokenForAcrRefreshToken (new)
Description Exchange AAD tokens for an ACR refresh Token
Reference Link ¶

⚼ Request

POST:  /oauth2/exchange
{
grant_type: string ,
service: string ,
tenant: string ,
refresh_token: string ,
access_token: string ,
api-version: string ,
}

⚐ Response (200)

{
refresh_token: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
Authentication_ExchangeAcrRefreshTokenForAcrAccessToken (new)
Description Exchange ACR Refresh token for an ACR Access Token
Reference Link ¶

⚼ Request

POST:  /oauth2/token
{
service: string ,
scope: string ,
refresh_token: string ,
grant_type: string ,
api-version: string ,
}

⚐ Response (200)

{
access_token: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}
Authentication_GetAcrAccessTokenFromLogin (new)
Description Exchange Username, Password and Scope for an ACR Access Token
Reference Link ¶

⚼ Request

GET:  /oauth2/token
{
service: string ,
scope: string ,
}

⚐ Response (200)

{
access_token: string ,
}

⚐ Response (default)

{
errors:
[
{
code: string ,
message: string ,
detail: object ,
}
,
]
,
}